This is an informational callout inside the header. It can contain multiple paragraphs, lists, and other markdown elements.
It can even contain markdown elements such as bold, italics inline code and blocks of code.
Copied
def hello():
return "Hello, world!"
Rotate your keys every 90 days.
Build completed successfully.
Production credentials should never be committed.
If you accidentally commit secrets, use git filter-repo to scrub them from your git history and rotate the compromised credentials immediately.
This parser edge case was fixed with a regression test.
Use `hl[9:11,22]` to highlight selected source lines.
Can callouts be nested? Click to find out!
Yes. You can nest infinitely
This is a nested callout with code!
Copied
def nested_callout():
return "This is a nested callout with code!"
"Documentation is a gift to the future."
Good Documentation elevates everyone.
Bad Documentation is worse than no documentation.
Copied
> [!info] Header
> This is an informational callout inside the header. It can contain multiple paragraphs, lists, and other markdown elements.
>
> It can even contain markdown elements such as **bold**, *italics*
> `inline code` and blocks of code.
> ```python
> def hello():
> return "Hello, world!"
> ```
> [!warning] Rotate your keys every 90 days.
> [!success] Build completed successfully.
> [!error] Production credentials should never be committed.
> If you accidentally commit secrets, use `git filter-repo` to scrub them from your git history and rotate the compromised credentials immediately.
> [!bug] This parser edge case was fixed with a regression test.
> [!example] Use `hl[9:11,22]` to highlight selected source lines.
> [!faq]- Can callouts be nested? Click to find out!
> > [!todo]- Yes. You can nest infinitely
> > > [!example]- This is a nested callout with code!
> > > ```python
> > > def nested_callout():
> > > return "This is a nested callout with code!"
> > > ```
> [!cite]- "Documentation is a gift to the future."
> > [!note] Good Documentation elevates everyone.
> > [!note] Bad Documentation is worse than no documentation.
Vyasa uses Obsidian-style blockquote callouts. Aliases such as warn, error, faq, help, check, done, summary, tldr, cite, and more are normalized automatically; + opens a foldable callout by default, and - starts it collapsed.
Supported callout families and aliases:
note
abstract: summary, tldr
info
todo
tip: hint, important
success: check, done
question: help, faq
warning: warn, caution, attention
failure: fail, missing
danger: error
bug
example
quote: cite
Custom types like > [!business-case] also render and expose data-callout="business-case" for CSS targeting.
Task lists can also render as richer task cards when you use task-list syntax with pipe-delimited metadata:
Copied
- [ ] Write a blog post | author: John Doe | deadline: 2024-12-31 | priority: high | status: in progress | project: Vyasa Blog
Supported task metadata families are:
person: owner, author, assignee, person, user, who